<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_voip_framer: xframer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_voip_framer
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xframer_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xframer.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the main header file for VoIP Framer core. </p>
<p>VoIP Framer core is used for generating Ethernet Headers for Incoming ST2022 RTP Packets or RTP Compliant Packet.</p>
<p>The VoIP Framer has 3 main Interface</p><ul>
<li>AXI4-Stream Interface for accepting Incoming Ethernet Packet</li>
<li>AXI4-Stream Interface for transmitting RTP Packet &lt;RTP Header | Payload&gt;</li>
<li>AXI4-Lite interface for processor, controls the VoIP Decapsulator.</li>
</ul>
<p>VoIP Framer Performs Following Operation</p><ul>
<li>Add Ethernet Header, (MAC, IP, &amp; UDP Header)</li>
<li>Statistic Monitoring of Incoming and Outgoing Packet</li>
</ul>
<p><b>Software Initialization &amp; Configuration</b></p>
<p>The application needs to do following steps in order for preparing the VoIP Framer core to be ready.</p>
<ul>
<li>Call XFramer_LookupConfig using a device ID to find the core configuration.</li>
<li>Call XFramer_CfgInitialize to initialize the device and the driver instance associated with it.</li>
</ul>
<p><b> Virtual Memory </b></p>
<p><b> Threads </b></p>
<p><b> Asserts </b></p>
<p><b> Building the driver </b></p>
<p>The VoIP Framer driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
<hr/>

1.00   mmo   02/12/16 Initial release.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_framer___header.html">XFramer_Header</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains VoIP Framer Header Generation Parameter.  <a href="struct_x_framer___header.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_framer___channel_cfg.html">XFramer_ChannelCfg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains VoIP Framer Channel Parameter Configuration.  <a href="struct_x_framer___channel_cfg.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_framer___config.html">XFramer_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the VoIP Framer core.  <a href="struct_x_framer___config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_framer.html">XFramer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> driver instance data.  <a href="struct_x_framer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a929c46374fdcb8e29e5776499f0f7184"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a929c46374fdcb8e29e5776499f0f7184">XFRAMER_H_</a></td></tr>
<tr class="memdesc:a929c46374fdcb8e29e5776499f0f7184"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#a929c46374fdcb8e29e5776499f0f7184">More...</a><br /></td></tr>
<tr class="separator:a929c46374fdcb8e29e5776499f0f7184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17f16c4ed0de21aa145010c77dc3142b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a17f16c4ed0de21aa145010c77dc3142b">XFramer_BusyBit</a>(InstancePtr)</td></tr>
<tr class="memdesc:a17f16c4ed0de21aa145010c77dc3142b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro Check the VoIP Framer Busy Status which indicates the core is still updating the registers.  <a href="#a17f16c4ed0de21aa145010c77dc3142b">More...</a><br /></td></tr>
<tr class="separator:a17f16c4ed0de21aa145010c77dc3142b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Transmit Enable/Disable</div></td></tr>
<tr class="memitem:a6904eb35bda608584dd35a4b752ff8aa"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a6904eb35bda608584dd35a4b752ff8aa">XFramerTXEnable</a> <tr class="memdesc:a6904eb35bda608584dd35a4b752ff8aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify specify the VoIP Framer to Enable/Disable the Transmission Packet.  <a href="xframer_8h.html#a6904eb35bda608584dd35a4b752ff8aa">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a6904eb35bda608584dd35a4b752ff8aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Enable VLAN</div></td></tr>
<tr class="memitem:a835c00cae4834613d3e3cc94b58db8a5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a835c00cae4834613d3e3cc94b58db8a5">XFramerVLANEnable</a> <tr class="memdesc:a835c00cae4834613d3e3cc94b58db8a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants contains component to Enable VLAN Packet Generation.  <a href="xframer_8h.html#a835c00cae4834613d3e3cc94b58db8a5">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a835c00cae4834613d3e3cc94b58db8a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">IPV6 Enable (Future Implementation)</div></td></tr>
<tr class="memitem:a9efd8852e5cff12c1f397b5bbdcdb21d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a9efd8852e5cff12c1f397b5bbdcdb21d">XFramerIPV6Enable</a> <tr class="memdesc:a9efd8852e5cff12c1f397b5bbdcdb21d"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants contains component to enable IPv6 Packet Generation.  <a href="xframer_8h.html#a9efd8852e5cff12c1f397b5bbdcdb21d">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a9efd8852e5cff12c1f397b5bbdcdb21d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a38f313fc8be26f7f46b8030b77c922c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_framer___config.html">XFramer_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a38f313fc8be26f7f46b8030b77c922c4">XFramer_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a38f313fc8be26f7f46b8030b77c922c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns a reference to an <a class="el" href="struct_x_framer___config.html" title="This typedef contains configuration information for the VoIP Framer core. ">XFramer_Config</a> structure based on the core id, <em>DeviceId</em>.  <a href="#a38f313fc8be26f7f46b8030b77c922c4">More...</a><br /></td></tr>
<tr class="separator:a38f313fc8be26f7f46b8030b77c922c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa750c7ac249efbc8b9abbbfb977d3a5f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#aa750c7ac249efbc8b9abbbfb977d3a5f">XFramer_CfgInitialize</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, <a class="el" href="struct_x_framer___config.html">XFramer_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:aa750c7ac249efbc8b9abbbfb977d3a5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the VoIP Framer core.  <a href="#aa750c7ac249efbc8b9abbbfb977d3a5f">More...</a><br /></td></tr>
<tr class="separator:aa750c7ac249efbc8b9abbbfb977d3a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac389124dce8048d1332f35a44b00a74a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ac389124dce8048d1332f35a44b00a74a">XFramer_CoreConfig</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:ac389124dce8048d1332f35a44b00a74a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the entire VoIP Framer based on user configured value.  <a href="#ac389124dce8048d1332f35a44b00a74a">More...</a><br /></td></tr>
<tr class="separator:ac389124dce8048d1332f35a44b00a74a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef1808598f04a453b59d48dbb46fc9cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#aef1808598f04a453b59d48dbb46fc9cd">XFramer_CoreChannelConfig</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:aef1808598f04a453b59d48dbb46fc9cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the entire Channel Space of VoIP Framer based on user configured value.  <a href="#aef1808598f04a453b59d48dbb46fc9cd">More...</a><br /></td></tr>
<tr class="separator:aef1808598f04a453b59d48dbb46fc9cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1769857f4d400c8dffbda8fbce01c5d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a1769857f4d400c8dffbda8fbce01c5d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Configures the VoIP Framer Channels Parameter.  <a href="#a1769857f4d400c8dffbda8fbce01c5d8">More...</a><br /></td></tr>
<tr class="separator:a1769857f4d400c8dffbda8fbce01c5d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae240a50d845e83cf86b06bc238f4f602"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_framer___channel_cfg.html">XFramer_ChannelCfg</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ae240a50d845e83cf86b06bc238f4f602">XFramer_ChStatus</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:ae240a50d845e83cf86b06bc238f4f602"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Reads the VoIP Framer Channels Parameter Register.  <a href="#ae240a50d845e83cf86b06bc238f4f602">More...</a><br /></td></tr>
<tr class="separator:ae240a50d845e83cf86b06bc238f4f602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accda8c5474500d6ef1330aa8803dbc22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_framer___config.html">XFramer_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#accda8c5474500d6ef1330aa8803dbc22">XFramer_CoreInfo</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:accda8c5474500d6ef1330aa8803dbc22"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the Core Information (Configured by user through GUI), in the VoIP Framer Register.  <a href="#accda8c5474500d6ef1330aa8803dbc22">More...</a><br /></td></tr>
<tr class="separator:accda8c5474500d6ef1330aa8803dbc22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5397e1f41e72df0987c0b28d3c7117e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#aa5397e1f41e72df0987c0b28d3c7117e">XFramer_SoftReset</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:aa5397e1f41e72df0987c0b28d3c7117e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function perform software resets on VoIP Framer, which clears all the registers.  <a href="#aa5397e1f41e72df0987c0b28d3c7117e">More...</a><br /></td></tr>
<tr class="separator:aa5397e1f41e72df0987c0b28d3c7117e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac297d2bb05b8223e943e53988cc6d149"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ac297d2bb05b8223e943e53988cc6d149">XFramer_ChannelUpdate</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:ac297d2bb05b8223e943e53988cc6d149"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function send a pulse on VoIP Framer to update the configured channel.  <a href="#ac297d2bb05b8223e943e53988cc6d149">More...</a><br /></td></tr>
<tr class="separator:ac297d2bb05b8223e943e53988cc6d149"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6ef8ec5049830215f10f450e8b91580"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:aa6ef8ec5049830215f10f450e8b91580"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function accesses the current configuration channel.  <a href="#aa6ef8ec5049830215f10f450e8b91580">More...</a><br /></td></tr>
<tr class="separator:aa6ef8ec5049830215f10f450e8b91580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f99403fb4bf0d9cf0bc31c62cf112a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a3f99403fb4bf0d9cf0bc31c62cf112a4">XFramer_EthSrcAddr0</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:a3f99403fb4bf0d9cf0bc31c62cf112a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the Lower Ethernet MAC Source Address.  <a href="#a3f99403fb4bf0d9cf0bc31c62cf112a4">More...</a><br /></td></tr>
<tr class="separator:a3f99403fb4bf0d9cf0bc31c62cf112a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1b4f0e34af2a276bdb443abe460eea3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ae1b4f0e34af2a276bdb443abe460eea3">XFramer_EthSrcAddr1</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:ae1b4f0e34af2a276bdb443abe460eea3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the Higher Ethernet MAC Source Address.  <a href="#ae1b4f0e34af2a276bdb443abe460eea3">More...</a><br /></td></tr>
<tr class="separator:ae1b4f0e34af2a276bdb443abe460eea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9ce219cfa32b0a9a00cd55c68065162"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ad9ce219cfa32b0a9a00cd55c68065162">XFramer_GetEthSrcAddr1</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:ad9ce219cfa32b0a9a00cd55c68065162"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Gets the Lower Ethernet MAC Source Address from Register.  <a href="#ad9ce219cfa32b0a9a00cd55c68065162">More...</a><br /></td></tr>
<tr class="separator:ad9ce219cfa32b0a9a00cd55c68065162"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecff75034c9dc2d4536386229d5c7c23"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#aecff75034c9dc2d4536386229d5c7c23">XFramer_GetEthSrcAddr0</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:aecff75034c9dc2d4536386229d5c7c23"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Gets the Lower Ethernet MAC Source Address from Register.  <a href="#aecff75034c9dc2d4536386229d5c7c23">More...</a><br /></td></tr>
<tr class="separator:aecff75034c9dc2d4536386229d5c7c23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84da8b323c4e01b64e75aab6441a05da"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a84da8b323c4e01b64e75aab6441a05da">XFramer_GetPeakBufferLevel</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:a84da8b323c4e01b64e75aab6441a05da"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Gets the Peak Observed Buffer Level.  <a href="#a84da8b323c4e01b64e75aab6441a05da">More...</a><br /></td></tr>
<tr class="separator:a84da8b323c4e01b64e75aab6441a05da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae21f373e9204a25c267b7753ef3aa7a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ae21f373e9204a25c267b7753ef3aa7a5">XFramer_ClearPeakBufferLevel</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:ae21f373e9204a25c267b7753ef3aa7a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Clears the Peak Observed Buffer Level Register.  <a href="#ae21f373e9204a25c267b7753ef3aa7a5">More...</a><br /></td></tr>
<tr class="separator:ae21f373e9204a25c267b7753ef3aa7a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d69b4c8cc74fa553cf800ffe00ec3e3"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a1d69b4c8cc74fa553cf800ffe00ec3e3">XFramer_GetRXPcktCnt</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:a1d69b4c8cc74fa553cf800ffe00ec3e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Gets the Current Received Packet Count Statistic.  <a href="#a1d69b4c8cc74fa553cf800ffe00ec3e3">More...</a><br /></td></tr>
<tr class="separator:a1d69b4c8cc74fa553cf800ffe00ec3e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a341f430ebd303c8042fd2d47c1a4c901"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a341f430ebd303c8042fd2d47c1a4c901">XFramer_ClearRXPcktCnt</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:a341f430ebd303c8042fd2d47c1a4c901"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Clears the Received Packet Count Statistic Register.  <a href="#a341f430ebd303c8042fd2d47c1a4c901">More...</a><br /></td></tr>
<tr class="separator:a341f430ebd303c8042fd2d47c1a4c901"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a6a51809f3695599dc2de8b320db68"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ab9a6a51809f3695599dc2de8b320db68">XFramer_GetDropPcktCnt</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:ab9a6a51809f3695599dc2de8b320db68"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Gets the Current Drop Packet Count Statistic.  <a href="#ab9a6a51809f3695599dc2de8b320db68">More...</a><br /></td></tr>
<tr class="separator:ab9a6a51809f3695599dc2de8b320db68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3116aed7708b386047f6d90f189e33ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a3116aed7708b386047f6d90f189e33ae">XFramer_ClearDropPcktCnt</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr)</td></tr>
<tr class="memdesc:a3116aed7708b386047f6d90f189e33ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Clears the Drop Packet Count Statistic Register.  <a href="#a3116aed7708b386047f6d90f189e33ae">More...</a><br /></td></tr>
<tr class="separator:a3116aed7708b386047f6d90f189e33ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b5a6c03d693fdfc5a899f81eddb893"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ae0b5a6c03d693fdfc5a899f81eddb893">XFramer_TransmitEnable</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:ae0b5a6c03d693fdfc5a899f81eddb893"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the Transmission Enable Bit.  <a href="#ae0b5a6c03d693fdfc5a899f81eddb893">More...</a><br /></td></tr>
<tr class="separator:ae0b5a6c03d693fdfc5a899f81eddb893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae705265bfe690af89d69419118a9236c"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ae705265bfe690af89d69419118a9236c">XFramer_GetTransmitEnable</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:ae705265bfe690af89d69419118a9236c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Gets the Current Configure Transmission Enable Bit.  <a href="#ae705265bfe690af89d69419118a9236c">More...</a><br /></td></tr>
<tr class="separator:ae705265bfe690af89d69419118a9236c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a806708bae65853e02861bc122709b342"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a806708bae65853e02861bc122709b342">XFramer_EthDestAddr0</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a806708bae65853e02861bc122709b342"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the Lower 32 Bit Ethernet Destination MAC Address.  <a href="#a806708bae65853e02861bc122709b342">More...</a><br /></td></tr>
<tr class="separator:a806708bae65853e02861bc122709b342"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbff44559195d5a58bfb21238c5e9d5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#abbff44559195d5a58bfb21238c5e9d5a">XFramer_EthDestAddr1</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:abbff44559195d5a58bfb21238c5e9d5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the Higher 16 Bit Ethernet Destination MAC Address.  <a href="#abbff44559195d5a58bfb21238c5e9d5a">More...</a><br /></td></tr>
<tr class="separator:abbff44559195d5a58bfb21238c5e9d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a268fd6e2b253de8d187270c877a6543e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a268fd6e2b253de8d187270c877a6543e">XFramer_VLANID</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a268fd6e2b253de8d187270c877a6543e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the VLAN ID of the Ethernet Packet.  <a href="#a268fd6e2b253de8d187270c877a6543e">More...</a><br /></td></tr>
<tr class="separator:a268fd6e2b253de8d187270c877a6543e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a716dd945dbe92cdf0bce3c6bac35d2eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a716dd945dbe92cdf0bce3c6bac35d2eb">XFramer_SetVLAN</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a716dd945dbe92cdf0bce3c6bac35d2eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the Core to Generate Packets with VLAN.  <a href="#a716dd945dbe92cdf0bce3c6bac35d2eb">More...</a><br /></td></tr>
<tr class="separator:a716dd945dbe92cdf0bce3c6bac35d2eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bd914b11eb7c0e7709d34f48a1c8e51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a7bd914b11eb7c0e7709d34f48a1c8e51">XFramer_MediaTOS</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a7bd914b11eb7c0e7709d34f48a1c8e51"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the Media Type of Service (TOS).  <a href="#a7bd914b11eb7c0e7709d34f48a1c8e51">More...</a><br /></td></tr>
<tr class="separator:a7bd914b11eb7c0e7709d34f48a1c8e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1755eceed56ae0c4e235800148ec3fb9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a1755eceed56ae0c4e235800148ec3fb9">XFramer_MediaTTL</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a1755eceed56ae0c4e235800148ec3fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the Media Time-To-Live (TTL).  <a href="#a1755eceed56ae0c4e235800148ec3fb9">More...</a><br /></td></tr>
<tr class="separator:a1755eceed56ae0c4e235800148ec3fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98aea3b73e6afb146dddf3e2e5c69305"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a98aea3b73e6afb146dddf3e2e5c69305">XFramer_FECTOS</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a98aea3b73e6afb146dddf3e2e5c69305"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the FEC Type of Service (TOS).  <a href="#a98aea3b73e6afb146dddf3e2e5c69305">More...</a><br /></td></tr>
<tr class="separator:a98aea3b73e6afb146dddf3e2e5c69305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91da7b9e5f7b32a678fdd1db7e5312fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a91da7b9e5f7b32a678fdd1db7e5312fd">XFramer_FECTTL</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a91da7b9e5f7b32a678fdd1db7e5312fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Set the FEC Time-To-Live (TTL).  <a href="#a91da7b9e5f7b32a678fdd1db7e5312fd">More...</a><br /></td></tr>
<tr class="separator:a91da7b9e5f7b32a678fdd1db7e5312fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b6240b876fc403d2d23dcde6c6977bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a8b6240b876fc403d2d23dcde6c6977bc">XFramer_IP0Dest</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a8b6240b876fc403d2d23dcde6c6977bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the IP Destination Address.  <a href="#a8b6240b876fc403d2d23dcde6c6977bc">More...</a><br /></td></tr>
<tr class="separator:a8b6240b876fc403d2d23dcde6c6977bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0457387122a5370d47220c26a32e534d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a0457387122a5370d47220c26a32e534d">XFramer_IP0Src</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a0457387122a5370d47220c26a32e534d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the IP Source Address.  <a href="#a0457387122a5370d47220c26a32e534d">More...</a><br /></td></tr>
<tr class="separator:a0457387122a5370d47220c26a32e534d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34574f9eeef0cd125c4347574f9d343a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a34574f9eeef0cd125c4347574f9d343a">XFramer_UDPDest</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a34574f9eeef0cd125c4347574f9d343a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the UDP Destination Port.  <a href="#a34574f9eeef0cd125c4347574f9d343a">More...</a><br /></td></tr>
<tr class="separator:a34574f9eeef0cd125c4347574f9d343a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe1042eace723c1702fcb02ce0ca07ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#abe1042eace723c1702fcb02ce0ca07ce">XFramer_UDPSrc</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:abe1042eace723c1702fcb02ce0ca07ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the UDP Source Port.  <a href="#abe1042eace723c1702fcb02ce0ca07ce">More...</a><br /></td></tr>
<tr class="separator:abe1042eace723c1702fcb02ce0ca07ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a879bf7d43faf2dd936d2633b0bc7d486"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#a879bf7d43faf2dd936d2633b0bc7d486">XFramer_GetTXPcktCnt</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:a879bf7d43faf2dd936d2633b0bc7d486"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Gets the current transmitted packet count statistic.  <a href="#a879bf7d43faf2dd936d2633b0bc7d486">More...</a><br /></td></tr>
<tr class="separator:a879bf7d43faf2dd936d2633b0bc7d486"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac87bf36dcc5af44654b632b611b10038"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer_8h.html#ac87bf36dcc5af44654b632b611b10038">XFramer_ClearTXPcktCnt</a> (<a class="el" href="struct_x_framer.html">XFramer</a> *InstancePtr, u16 Channels)</td></tr>
<tr class="memdesc:ac87bf36dcc5af44654b632b611b10038"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Clears the current transmitted packet count statistic register.  <a href="#ac87bf36dcc5af44654b632b611b10038">More...</a><br /></td></tr>
<tr class="separator:ac87bf36dcc5af44654b632b611b10038"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a17f16c4ed0de21aa145010c77dc3142b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17f16c4ed0de21aa145010c77dc3142b">&#9670;&nbsp;</a></span>XFramer_BusyBit</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XFramer_BusyBit</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, (XFRAMER_CONTROL)) \</div><div class="line">          &amp; (XFRAMER_STATUS_UPDATE_BUSY_MASK)</div><div class="ttc" id="xframer__hw_8h_html_a0eba32102023b9a314b5593964b8d88e"><div class="ttname"><a href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a></div><div class="ttdeci">#define XFramer_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This macro reads a value from a VoIP Framer register. </div><div class="ttdef"><b>Definition:</b> xframer_hw.h:196</div></div>
</div><!-- fragment -->
<p>This macro Check the VoIP Framer Busy Status which indicates the core is still updating the registers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>BusyBitStatus.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<pre class="fragment">  void XFramer_AssertSoftReset(XFramer *InstancePtr)</pre> 
<p class="reference">Referenced by <a class="el" href="xframer_8h.html#aa750c7ac249efbc8b9abbbfb977d3a5f">XFramer_CfgInitialize()</a>, and <a class="el" href="xframer_8h.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>.</p>

</div>
</div>
<a id="a929c46374fdcb8e29e5776499f0f7184"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a929c46374fdcb8e29e5776499f0f7184">&#9670;&nbsp;</a></span>XFRAMER_H_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XFRAMER_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a9efd8852e5cff12c1f397b5bbdcdb21d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9efd8852e5cff12c1f397b5bbdcdb21d">&#9670;&nbsp;</a></span>XFramerIPV6Enable</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xframer_8h.html#a9efd8852e5cff12c1f397b5bbdcdb21d">XFramerIPV6Enable</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants contains component to enable IPv6 Packet Generation. </p>

</div>
</div>
<a id="a6904eb35bda608584dd35a4b752ff8aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6904eb35bda608584dd35a4b752ff8aa">&#9670;&nbsp;</a></span>XFramerTXEnable</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xframer_8h.html#a6904eb35bda608584dd35a4b752ff8aa">XFramerTXEnable</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify specify the VoIP Framer to Enable/Disable the Transmission Packet. </p>

</div>
</div>
<a id="a835c00cae4834613d3e3cc94b58db8a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a835c00cae4834613d3e3cc94b58db8a5">&#9670;&nbsp;</a></span>XFramerVLANEnable</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xframer_8h.html#a835c00cae4834613d3e3cc94b58db8a5">XFramerVLANEnable</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants contains component to Enable VLAN Packet Generation. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa750c7ac249efbc8b9abbbfb977d3a5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa750c7ac249efbc8b9abbbfb977d3a5f">&#9670;&nbsp;</a></span>XFramer_CfgInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XFramer_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_framer___config.html">XFramer_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the VoIP Framer core. </p>
<p>This function must be called prior to using the VoIP Framer core. Initialization of the VoIP Framer includes setting up the instance data and ensuring the hardware is in a quiescent state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XDecap core instance. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>points to the configuration structure associated with the VoIP Framer core. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if XFramer_CfgInitialize was successful.</li>
<li>XST_FAILURE if Channel Number has mismatched with value reflected on the register, and if the Overflow strategy has mismatched with the value reflected on the register.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="struct_x_framer___config.html#a03ce9100391652b3b6a89f40b403f4d1">XFramer_Config::HWChannelNumber</a>, <a class="el" href="struct_x_framer___config.html#afc3f2517774bf9a5cd8adc0687cb27d4">XFramer_Config::OverflowHandlingStrategy</a>, <a class="el" href="xframer_8h.html#a17f16c4ed0de21aa145010c77dc3142b">XFramer_BusyBit</a>, <a class="el" href="xframer_8c.html#accda8c5474500d6ef1330aa8803dbc22">XFramer_CoreInfo()</a>, and <a class="el" href="xframer_8c.html#aa5397e1f41e72df0987c0b28d3c7117e">XFramer_SoftReset()</a>.</p>

</div>
</div>
<a id="aa6ef8ec5049830215f10f450e8b91580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6ef8ec5049830215f10f450e8b91580">&#9670;&nbsp;</a></span>XFramer_ChannelAccess()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_ChannelAccess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function accesses the current configuration channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xframer_8h.html#a17f16c4ed0de21aa145010c77dc3142b">XFramer_BusyBit</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>, <a class="el" href="xframer_8h.html#ae240a50d845e83cf86b06bc238f4f602">XFramer_ChStatus()</a>, <a class="el" href="xframer_8h.html#ac87bf36dcc5af44654b632b611b10038">XFramer_ClearTXPcktCnt()</a>, <a class="el" href="xframer_8h.html#a806708bae65853e02861bc122709b342">XFramer_EthDestAddr0()</a>, <a class="el" href="xframer_8h.html#abbff44559195d5a58bfb21238c5e9d5a">XFramer_EthDestAddr1()</a>, <a class="el" href="xframer_8h.html#a98aea3b73e6afb146dddf3e2e5c69305">XFramer_FECTOS()</a>, <a class="el" href="xframer_8h.html#a91da7b9e5f7b32a678fdd1db7e5312fd">XFramer_FECTTL()</a>, <a class="el" href="xframer_8h.html#ae705265bfe690af89d69419118a9236c">XFramer_GetTransmitEnable()</a>, <a class="el" href="xframer_8h.html#a879bf7d43faf2dd936d2633b0bc7d486">XFramer_GetTXPcktCnt()</a>, <a class="el" href="xframer_8h.html#a8b6240b876fc403d2d23dcde6c6977bc">XFramer_IP0Dest()</a>, <a class="el" href="xframer_8h.html#a0457387122a5370d47220c26a32e534d">XFramer_IP0Src()</a>, <a class="el" href="xframer_8h.html#a7bd914b11eb7c0e7709d34f48a1c8e51">XFramer_MediaTOS()</a>, <a class="el" href="xframer_8h.html#a1755eceed56ae0c4e235800148ec3fb9">XFramer_MediaTTL()</a>, <a class="el" href="xframer_8h.html#a716dd945dbe92cdf0bce3c6bac35d2eb">XFramer_SetVLAN()</a>, <a class="el" href="xframer_8h.html#ae0b5a6c03d693fdfc5a899f81eddb893">XFramer_TransmitEnable()</a>, <a class="el" href="xframer_8h.html#a34574f9eeef0cd125c4347574f9d343a">XFramer_UDPDest()</a>, <a class="el" href="xframer_8h.html#abe1042eace723c1702fcb02ce0ca07ce">XFramer_UDPSrc()</a>, and <a class="el" href="xframer_8h.html#a268fd6e2b253de8d187270c877a6543e">XFramer_VLANID()</a>.</p>

</div>
</div>
<a id="a1769857f4d400c8dffbda8fbce01c5d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1769857f4d400c8dffbda8fbce01c5d8">&#9670;&nbsp;</a></span>XFramer_ChannelConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_ChannelConfig </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Configures the VoIP Framer Channels Parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, <a class="el" href="xframer_8c.html#a806708bae65853e02861bc122709b342">XFramer_EthDestAddr0()</a>, <a class="el" href="xframer_8c.html#abbff44559195d5a58bfb21238c5e9d5a">XFramer_EthDestAddr1()</a>, <a class="el" href="xframer_8c.html#a98aea3b73e6afb146dddf3e2e5c69305">XFramer_FECTOS()</a>, <a class="el" href="xframer_8c.html#a91da7b9e5f7b32a678fdd1db7e5312fd">XFramer_FECTTL()</a>, <a class="el" href="xframer_8c.html#a8b6240b876fc403d2d23dcde6c6977bc">XFramer_IP0Dest()</a>, <a class="el" href="xframer_8c.html#a0457387122a5370d47220c26a32e534d">XFramer_IP0Src()</a>, <a class="el" href="xframer_8c.html#a7bd914b11eb7c0e7709d34f48a1c8e51">XFramer_MediaTOS()</a>, <a class="el" href="xframer_8c.html#a1755eceed56ae0c4e235800148ec3fb9">XFramer_MediaTTL()</a>, <a class="el" href="xframer_8c.html#a716dd945dbe92cdf0bce3c6bac35d2eb">XFramer_SetVLAN()</a>, <a class="el" href="xframer_8c.html#ae0b5a6c03d693fdfc5a899f81eddb893">XFramer_TransmitEnable()</a>, <a class="el" href="xframer_8c.html#a34574f9eeef0cd125c4347574f9d343a">XFramer_UDPDest()</a>, <a class="el" href="xframer_8c.html#abe1042eace723c1702fcb02ce0ca07ce">XFramer_UDPSrc()</a>, and <a class="el" href="xframer_8c.html#a268fd6e2b253de8d187270c877a6543e">XFramer_VLANID()</a>.</p>

</div>
</div>
<a id="ac297d2bb05b8223e943e53988cc6d149"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac297d2bb05b8223e943e53988cc6d149">&#9670;&nbsp;</a></span>XFramer_ChannelUpdate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_ChannelUpdate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function send a pulse on VoIP Framer to update the configured channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="ae240a50d845e83cf86b06bc238f4f602"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae240a50d845e83cf86b06bc238f4f602">&#9670;&nbsp;</a></span>XFramer_ChStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_framer___channel_cfg.html">XFramer_ChannelCfg</a> XFramer_ChStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Reads the VoIP Framer Channels Parameter Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="a3116aed7708b386047f6d90f189e33ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3116aed7708b386047f6d90f189e33ae">&#9670;&nbsp;</a></span>XFramer_ClearDropPcktCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_ClearDropPcktCnt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Clears the Drop Packet Count Statistic Register. </p>
<p>This is Self Clear Register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

</div>
</div>
<a id="ae21f373e9204a25c267b7753ef3aa7a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae21f373e9204a25c267b7753ef3aa7a5">&#9670;&nbsp;</a></span>XFramer_ClearPeakBufferLevel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_ClearPeakBufferLevel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Clears the Peak Observed Buffer Level Register. </p>
<p>This is Self Clear Register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

</div>
</div>
<a id="a341f430ebd303c8042fd2d47c1a4c901"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a341f430ebd303c8042fd2d47c1a4c901">&#9670;&nbsp;</a></span>XFramer_ClearRXPcktCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_ClearRXPcktCnt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Clears the Received Packet Count Statistic Register. </p>
<p>This is Self Clear Register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

</div>
</div>
<a id="ac87bf36dcc5af44654b632b611b10038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac87bf36dcc5af44654b632b611b10038">&#9670;&nbsp;</a></span>XFramer_ClearTXPcktCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_ClearTXPcktCnt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Clears the current transmitted packet count statistic register. </p>
<p>This is a self clear register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

</div>
</div>
<a id="aef1808598f04a453b59d48dbb46fc9cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef1808598f04a453b59d48dbb46fc9cd">&#9670;&nbsp;</a></span>XFramer_CoreChannelConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_CoreChannelConfig </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the entire Channel Space of VoIP Framer based on user configured value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#ac389124dce8048d1332f35a44b00a74a">XFramer_CoreConfig()</a>.</p>

</div>
</div>
<a id="ac389124dce8048d1332f35a44b00a74a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac389124dce8048d1332f35a44b00a74a">&#9670;&nbsp;</a></span>XFramer_CoreConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_CoreConfig </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the entire VoIP Framer based on user configured value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xframer_8c.html#aef1808598f04a453b59d48dbb46fc9cd">XFramer_CoreChannelConfig()</a>, <a class="el" href="xframer_8c.html#a3f99403fb4bf0d9cf0bc31c62cf112a4">XFramer_EthSrcAddr0()</a>, and <a class="el" href="xframer_8c.html#ae1b4f0e34af2a276bdb443abe460eea3">XFramer_EthSrcAddr1()</a>.</p>

</div>
</div>
<a id="accda8c5474500d6ef1330aa8803dbc22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accda8c5474500d6ef1330aa8803dbc22">&#9670;&nbsp;</a></span>XFramer_CoreInfo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_framer___config.html">XFramer_Config</a> XFramer_CoreInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the Core Information (Configured by user through GUI), in the VoIP Framer Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XFramer_Config_RegValue of the HW Channel Number and the Overflow Handling Strategy</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="struct_x_framer___config.html#a03ce9100391652b3b6a89f40b403f4d1">XFramer_Config::HWChannelNumber</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#aa750c7ac249efbc8b9abbbfb977d3a5f">XFramer_CfgInitialize()</a>.</p>

</div>
</div>
<a id="a806708bae65853e02861bc122709b342"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a806708bae65853e02861bc122709b342">&#9670;&nbsp;</a></span>XFramer_EthDestAddr0()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_EthDestAddr0 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the Lower 32 Bit Ethernet Destination MAC Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="abbff44559195d5a58bfb21238c5e9d5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbff44559195d5a58bfb21238c5e9d5a">&#9670;&nbsp;</a></span>XFramer_EthDestAddr1()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_EthDestAddr1 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the Higher 16 Bit Ethernet Destination MAC Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a3f99403fb4bf0d9cf0bc31c62cf112a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f99403fb4bf0d9cf0bc31c62cf112a4">&#9670;&nbsp;</a></span>XFramer_EthSrcAddr0()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_EthSrcAddr0 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the Lower Ethernet MAC Source Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#ac389124dce8048d1332f35a44b00a74a">XFramer_CoreConfig()</a>.</p>

</div>
</div>
<a id="ae1b4f0e34af2a276bdb443abe460eea3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1b4f0e34af2a276bdb443abe460eea3">&#9670;&nbsp;</a></span>XFramer_EthSrcAddr1()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_EthSrcAddr1 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the Higher Ethernet MAC Source Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#ac389124dce8048d1332f35a44b00a74a">XFramer_CoreConfig()</a>.</p>

</div>
</div>
<a id="a98aea3b73e6afb146dddf3e2e5c69305"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98aea3b73e6afb146dddf3e2e5c69305">&#9670;&nbsp;</a></span>XFramer_FECTOS()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_FECTOS </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the FEC Type of Service (TOS). </p>
<p>Component of the IP Header.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a91da7b9e5f7b32a678fdd1db7e5312fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91da7b9e5f7b32a678fdd1db7e5312fd">&#9670;&nbsp;</a></span>XFramer_FECTTL()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_FECTTL </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the FEC Time-To-Live (TTL). </p>
<p>Component of the IP Header.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="ab9a6a51809f3695599dc2de8b320db68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9a6a51809f3695599dc2de8b320db68">&#9670;&nbsp;</a></span>XFramer_GetDropPcktCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XFramer_GetDropPcktCnt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Gets the Current Drop Packet Count Statistic. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RegValue is the Current Drop Packet Count</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="aecff75034c9dc2d4536386229d5c7c23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecff75034c9dc2d4536386229d5c7c23">&#9670;&nbsp;</a></span>XFramer_GetEthSrcAddr0()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XFramer_GetEthSrcAddr0 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Gets the Lower Ethernet MAC Source Address from Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RegValue is the Ethernet Lower MAC Address Register Value.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="ad9ce219cfa32b0a9a00cd55c68065162"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9ce219cfa32b0a9a00cd55c68065162">&#9670;&nbsp;</a></span>XFramer_GetEthSrcAddr1()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XFramer_GetEthSrcAddr1 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Gets the Lower Ethernet MAC Source Address from Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RegValue is the Ethernet Lower MAC Address Register Value.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="a84da8b323c4e01b64e75aab6441a05da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84da8b323c4e01b64e75aab6441a05da">&#9670;&nbsp;</a></span>XFramer_GetPeakBufferLevel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XFramer_GetPeakBufferLevel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Gets the Peak Observed Buffer Level. </p>
<p>Ensure this value is not greater than the Elastic Buffer Set during Core Generation. This is Debug Function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RegValue is the Peak Observed Buffer Level</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="a1d69b4c8cc74fa553cf800ffe00ec3e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d69b4c8cc74fa553cf800ffe00ec3e3">&#9670;&nbsp;</a></span>XFramer_GetRXPcktCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XFramer_GetRXPcktCnt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Gets the Current Received Packet Count Statistic. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RegValue is the Current Received Packet Count</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="ae705265bfe690af89d69419118a9236c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae705265bfe690af89d69419118a9236c">&#9670;&nbsp;</a></span>XFramer_GetTransmitEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XFramer_GetTransmitEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Gets the Current Configure Transmission Enable Bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RegValue is the Transmission Enable Bit Register Value.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="a879bf7d43faf2dd936d2633b0bc7d486"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a879bf7d43faf2dd936d2633b0bc7d486">&#9670;&nbsp;</a></span>XFramer_GetTXPcktCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XFramer_GetTXPcktCnt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Gets the current transmitted packet count statistic. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

</div>
</div>
<a id="a8b6240b876fc403d2d23dcde6c6977bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b6240b876fc403d2d23dcde6c6977bc">&#9670;&nbsp;</a></span>XFramer_IP0Dest()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_IP0Dest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the IP Destination Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a0457387122a5370d47220c26a32e534d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0457387122a5370d47220c26a32e534d">&#9670;&nbsp;</a></span>XFramer_IP0Src()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_IP0Src </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the IP Source Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a38f313fc8be26f7f46b8030b77c922c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38f313fc8be26f7f46b8030b77c922c4">&#9670;&nbsp;</a></span>XFramer_LookupConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_framer___config.html">XFramer_Config</a>* XFramer_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns a reference to an <a class="el" href="struct_x_framer___config.html" title="This typedef contains configuration information for the VoIP Framer core. ">XFramer_Config</a> structure based on the core id, <em>DeviceId</em>. </p>
<p>The return value will refer to an entry in the device configuration table defined in the xframer_g.c file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique core ID of the Decap core for the lookup operation.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XFramer_LookupConfig returns a reference to a config record in the configuration table (in xframer_g.c) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="a7bd914b11eb7c0e7709d34f48a1c8e51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bd914b11eb7c0e7709d34f48a1c8e51">&#9670;&nbsp;</a></span>XFramer_MediaTOS()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_MediaTOS </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the Media Type of Service (TOS). </p>
<p>Component of the IP Header.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a1755eceed56ae0c4e235800148ec3fb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1755eceed56ae0c4e235800148ec3fb9">&#9670;&nbsp;</a></span>XFramer_MediaTTL()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_MediaTTL </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the Media Time-To-Live (TTL). </p>
<p>Component of the IP Header.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a716dd945dbe92cdf0bce3c6bac35d2eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a716dd945dbe92cdf0bce3c6bac35d2eb">&#9670;&nbsp;</a></span>XFramer_SetVLAN()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_SetVLAN </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the Core to Generate Packets with VLAN. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="aa5397e1f41e72df0987c0b28d3c7117e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5397e1f41e72df0987c0b28d3c7117e">&#9670;&nbsp;</a></span>XFramer_SoftReset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_SoftReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function perform software resets on VoIP Framer, which clears all the registers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#aa750c7ac249efbc8b9abbbfb977d3a5f">XFramer_CfgInitialize()</a>.</p>

</div>
</div>
<a id="ae0b5a6c03d693fdfc5a899f81eddb893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0b5a6c03d693fdfc5a899f81eddb893">&#9670;&nbsp;</a></span>XFramer_TransmitEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_TransmitEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Set the Transmission Enable Bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a34574f9eeef0cd125c4347574f9d343a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34574f9eeef0cd125c4347574f9d343a">&#9670;&nbsp;</a></span>XFramer_UDPDest()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_UDPDest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the UDP Destination Port. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="abe1042eace723c1702fcb02ce0ca07ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe1042eace723c1702fcb02ce0ca07ce">&#9670;&nbsp;</a></span>XFramer_UDPSrc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_UDPSrc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the UDP Source Port. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
<a id="a268fd6e2b253de8d187270c877a6543e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a268fd6e2b253de8d187270c877a6543e">&#9670;&nbsp;</a></span>XFramer_VLANID()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XFramer_VLANID </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_framer.html">XFramer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Channels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the VLAN ID of the Ethernet Packet. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_framer.html" title="The XFramer driver instance data. ">XFramer</a> core instance.</td></tr>
    <tr><td class="paramname">Channels</td><td>is current configured channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_framer___config.html#a78cfd0cd026a85e59715b8f989117e6e">XFramer_Config::BaseAddress</a>, <a class="el" href="xframer_8c.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, and <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#a1769857f4d400c8dffbda8fbce01c5d8">XFramer_ChannelConfig()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
